﻿/*
 * The MIT License
 * 
 * Copyright 2008 Jeppe Burchardt and Pimm Hogeling
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

package org.dr.actionconsole.events
{
	import flash.events.Event;
	import org.dr.actionconsole.Console;
	
	public class ConsoleEvent extends Event
	{
		public static const CONSOLE_INPUT:String = "consoleInput";
		
		public static const CONSOLE_FIRST_OPENED:String = "consoleFirstOpened";
		
		/**
		 * Text input typed by the user, if the type property is not ConsoleEvent.CONSOLE_INPUT this property will be null.
		 */
		public var input : String;
		
		public function ConsoleEvent(type:String, input:String=null) : void
		{
			super(type);
			this.input = input;
		}
		
		/**
		 * Duplicates the ConsoleEvent instance.
		 *
		 * @return	<Event> A new ConsoleEvent object that is identical to the original.
		 */
		public override function clone() : Event
		{
			return new ConsoleEvent(type, input);
		}
		
		
		public override function get currentTarget() : Object
		{
			return Console;
		}
		
		public override function get target() : Object
		{
			return Console;
		}
		
		/**
		 * Returns a string containing the type and the inputText properties of the ConsoleEvent object.
		 *
		 * @return	<String> A string containing the type and the inputText properties of the ConsoleEvent object.
		 */
		public override function toString() : String
		{
			return formatToString("ConsoleEvent", "type", "input"); 
		}
	}
	
}
